Package-level declarations

Types

Link copied to clipboard
sealed class AddNoteResult

Result type for add note operations.

Link copied to clipboard
sealed class DeleteNoteResult

Result type for delete note operations.

Link copied to clipboard
sealed class GetNoteResult

Result type for single note operations.

Link copied to clipboard
sealed class NoteChangeEvent

Sealed class representing different types of note change events that can be received via database observation and delta sync.

Link copied to clipboard
sealed class NotesResult

Result type for notes operations that gives clients control over loading states.

Link copied to clipboard
sealed class ToggleNotePinResult

Result type for toggle note pinned state operation.

Link copied to clipboard
sealed class UpdateNoteResult

Result type for update note operations.

Link copied to clipboard

Result type for update note visibility operation.

Link copied to clipboard
data class ZyncAddNoteContent(val note: String?, val noteType: String, val canNotifyOthers: Boolean, val noteVisibilityType: ZyncNoteVisibilityType, val attachments: List<ZyncNoteAttachment>?, val userMentions: List<String>?, val associatedJob: ZyncNoteAssociatedJob?, val associatedCustomer: ZyncNoteAssociatedCustomer?, val associatedOrganization: ZyncNoteAssociatedOrganization?, val associatedProperty: ZyncNoteAssociatedProperty?, val associatedAsset: ZyncNoteAssociatedAsset?, val associatedQuote: ZyncNoteAssociatedQuote?, val associatedInvoice: ZyncNoteAssociatedInvoice?, val associatedContract: ZyncNoteAssociatedContract?, val associatedRequest: ZyncNoteAssociatedRequest?, val associatedProject: ZyncNoteAssociatedProject?, val primaryModule: ZyncNotePrimaryModule, val isPinned: Boolean, val geoCoordinates: List<Double>?)

Content model for creating a new note with all associated metadata and relationships.

Link copied to clipboard
@ObjCName(name = "ZyncCreatedByCustomer")
data class ZyncCreatedByCustomer(val customerUid: String, val customerFirstName: String, val customerLastName: String?, val customerEmail: String?, val isDeleted: Boolean?)

Represents a customer who created a note.

Link copied to clipboard
data class ZyncNote(val noteUid: String, val noteType: String, val note: String?, val attachments: List<ZyncAttachment>?, val createdBy: ZyncCreatedByUser?, val createdByType: String?, val createdAt: String, val updatedAt: String, val isPrivate: Boolean?, val isPinned: Boolean, val visibleToCustomer: Boolean?, val visibleToFe: Boolean?, val isV2Note: Boolean, val geoCoordinates: List<Double>?, val createdByCustomer: ZyncCreatedByCustomer?, val isDeleted: Boolean, val noteVisibilityType: ZyncNoteVisibilityType, val userMentions: List<String>?, val attachment: String?, val associatedJob: ZyncNoteAssociatedJob?, val associatedProject: ZyncNoteAssociatedProject?, val associatedCustomer: ZyncNoteAssociatedCustomer?, val associatedOrganization: ZyncNoteAssociatedOrganization?, val associatedProperty: ZyncNoteAssociatedProperty?, val associatedAsset: ZyncNoteAssociatedAsset?, val associatedQuote: ZyncNoteAssociatedQuote?, val associatedInvoice: ZyncNoteAssociatedInvoice?, val associatedContract: ZyncNoteAssociatedContract?, val associatedRequest: ZyncNoteAssociatedRequest?, val jobUid: String?, val projectUid: String?, val customerUid: String?, val organizationUid: String?, val propertyUid: String?, val assetUid: String?, val estimateUid: String?, val invoiceUid: String?, val contractUid: String?, val requestUid: String?, val primaryModule: ZyncNotePrimaryModule, val noteUploadStatus: ZyncUploadStatus?, val isLegacyOfflineNote: Boolean) : Keyed<String>

Represents a note in the Zync system.

Link copied to clipboard
data class ZyncNoteAssociatedAsset(val assetUid: String, val assetName: String, val assetCode: String)

Represents an associated asset in a note.

Link copied to clipboard
data class ZyncNoteAssociatedContract(val contractUid: String, val contractNumber: Int, val name: String, val prefix: String?)

Represents an associated contract in a note.

Link copied to clipboard
data class ZyncNoteAssociatedCustomer(val customerUid: String, val customerFirstName: String, val customerLastName: String?)

Represents an associated customer in a note.

Link copied to clipboard
data class ZyncNoteAssociatedInvoice(val invoiceUid: String, val invoiceNumber: Int, val prefix: String?)

Represents an associated invoice in a note.

Link copied to clipboard
data class ZyncNoteAssociatedJob(val jobUid: String, val workOrderNumber: Int, val jobTitle: String, val prefix: String?)

Represents an associated job in a note.

Link copied to clipboard
data class ZyncNoteAssociatedOrganization(val organizationUid: String, val organizationName: String)

Represents an associated organization in a note.

Link copied to clipboard
data class ZyncNoteAssociatedProject(val projectUid: String, val projectNumber: Int, val projectTitle: String, val prefix: String?)

Represents an associated project in a note.

Link copied to clipboard
data class ZyncNoteAssociatedProperty(val propertyUid: String, val propertyName: String)

Represents an associated property in a note.

Link copied to clipboard
data class ZyncNoteAssociatedQuote(val quoteUid: String, val quoteNumber: Int, val prefix: String?)

Represents an associated quote/estimate in a note.

Link copied to clipboard
data class ZyncNoteAssociatedRequest(val requestUid: String)

Represents an associated request in a note.

Link copied to clipboard
data class ZyncNoteAttachment(val attachmentUid: String, val attachment: String, val attachmentName: String, val attachmentType: String, val attachmentSize: Long, val attachmentDescription: String?, val tags: List<String>?, val thumbnailUrl: String?, val latitude: Double?, val longitude: Double?)

Represents an attachment associated with a note.

Link copied to clipboard
data class ZyncNotePrimaryModule(val module: String, val moduleUid: String)

Represents the primary module that a note is associated with.

Link copied to clipboard

Represents the visibility type of a note.

Link copied to clipboard
data class ZyncUpdateNoteContent(val noteUid: String, val note: String?, val noteType: String, val noteVisibilityType: ZyncNoteVisibilityType, val attachments: List<ZyncNoteAttachment>?, val userMentions: List<String>?, val associatedJob: ZyncNoteAssociatedJob?, val associatedCustomer: ZyncNoteAssociatedCustomer?, val associatedOrganization: ZyncNoteAssociatedOrganization?, val associatedProperty: ZyncNoteAssociatedProperty?, val associatedAsset: ZyncNoteAssociatedAsset?, val associatedQuote: ZyncNoteAssociatedQuote?, val associatedInvoice: ZyncNoteAssociatedInvoice?, val associatedContract: ZyncNoteAssociatedContract?, val associatedRequest: ZyncNoteAssociatedRequest?, val associatedProject: ZyncNoteAssociatedProject?, val geoCoordinates: List<Double>?, val isV2Note: Boolean, val isPinned: Boolean)

Content model for updating an existing note with modified metadata and relationships.